Internet Info 1994 March/Internet Info CD-ROM (Walnut Creek) (March 1994).iso/inet/internet-drafts/2-scribe.template

Text File | 1993-03-03 | 13.4 KB | 486 lines

Internet-Draft                                             Glenn Trewitt
                                                               July 1991



                      RFC Document Type for Scribe


STATUS OF THIS MEMO

        This odd Internet Draft is posted for the convenience of
        authors who wish to prepare documents in the style of
        RFC's.  This Scribe document type can produce either RFC's
        or Internet Drafts, provided that the author follows the
        guidlines listed in the file IETF/1id-guidelines in all the
        IETF directories.


ABSTRACT

        This Internet Draft contains a Scribe document type
        definition for producing documents in the formats of either
        Request for Comments (RFC's) or Internet Drafts.
          NOTE: Scribe is a trademark of Scribe Systems.
        This definition can produce either text or PostScript
        format output.
          NOTE: PostScript is a trademark of Adobe Systems, Inc.


1 Installation

   The file appended at the end of this document should be named
   "rfc.mak" and installed in one of the following locations:

      - The same directory that you run Scribe from.

      - The system-wide Scribe "database" directory.  Talk to your
        system administrator.

      - A private Scribe "database" directory.  You will need to
        use the command "@use(database = 'directory-name')" at the
        beginning of your .mss file to tell Scribe where to find
        the file.


2 Usage

   To make an RFC, the following preamble should be included at the
   beginning of your .mss file:






Glenn Trewitt                                                   [Page 1]

Internet-Draft        RFC Document Type for Scribe          12-July-1991


       @device(pagedfile)
       @make(rfc)

       @RFC(
               Title = "Full Title of RFC",
               Authors = "Full Author list for Title Page"
               WG = "Working Group Name",
               Number = "####",
               ShortTitle = "Short Title for Page Headings",
               ShortAuthors = "Authors for Page Headings",
               Date = "12-July-1991"
       )

   To make an Internet Draft, the following preamble should be included
   at the beginning of your .mss file:

       @device(pagedfile)
       @make(rfc)

       @InternetDraft(
               Title = "Full Title of Internet Draft",
               Authors = "Full Author list for Title Page"
               WG = "Working Group Name",
               ShortTitle = "Short Title for Page Headings",
               ShortAuthors = "Authors for Page Headings",
               Date = "12-July-1991"
       )

   The "Authors" and "Title" parameters may have multiple lines; they
   are printed at the top of the first page.  The "ShortTitle" and
   "ShortAuthors" parameters are put in the page heading, and should fit
   together on one line.

   After the preamble, the "Status of this memo" and Abstract sections
   can be produced using these environments:

       @begin(status)
       "Status of this memo" paragraph goes here.
       @end(status)

       @begin(abstract)
       Abstract of document...
       @end(abstract)

   The remainder of your document should be regular Scribe commands.
   The capabilities are similar to the standard "report" document type.
   Footnotes (@foot command) can be used; they are printed in-line on
   non-laser printer devices.
     NOTE: Here is an example of a long footnote.  As you can see, in
           the text document it is nicely offset from the main body.
           In laser printer output, it is printed at the bottom of the
           page, as usual.
Glenn Trewitt                                                   [Page 2]

Internet-Draft        RFC Document Type for Scribe          12-July-1991


   The following device types can be used with the RFC document type:
      - PostScript
      - any "ScaleableLaser" device
      - File
      - PagedFile
      - CRT



I. AUTHOR'S ADDRESS

   Glenn Trewitt
   [e-mail]



II. RFC.MAK

   The rfc.mak file is appended after this page.

































Glenn Trewitt                                                   [Page 3]

@Comment[ Loosely derived from Unilogic "Report" document type. ]

@Comment[
    Scribe format for an RFC or Internet Draft

    18 July 1984    Jeff Mogul    Stanford
    Heavily hacked over
    July 1987    Glenn Trewitt    Stanford
    Tweaked for release, added Internet Draft
    July 1991    Glenn Trewitt    Digital Equipment Corp.

Usage:
    @device(pagedfile)
    @make(rfc)

    @RFC(
        Title = "Full Title of RFC",
        Authors = "Full Author list for Title Page"
        WG = "Working Group Name",
        Number = "####",
        ShortTitle = "Short Title for Page Headings",
        ShortAuthors = "Authors for Page Headings",
        Date = "12-July-1991"
    )
        --- OR ---
    @InternetDraft(
        Title = "Full Title of Internet Draft",
        Authors = "Full Author list for Title Page"
        WG = "Working Group Name",
        ShortTitle = "Short Title for Page Headings",
        ShortAuthors = "Authors for Page Headings",
        Date = "12-July-1991"
    )

    @begin(status)
    "Status of this memo" paragraph goes here.
    @end(status)

    @begin(abstract)
    Abstract of document...
    @end(abstract)
]

@Marker(Make,RFC,File,PagedFile,CRT)
@Declare(PaperLength 58)
@Define(BodyStyle,Spacing 1)
@Define(NoteStyle,Spacing 1)

@Style(TopMargin 4, BottomMargin 3)
@Style(Hyphenation Off, Justification Off)
@Style(WidowAction ForceWarn)
@Style(References=CACM)
@Style(Date= "March 1952", FileDate= "March 1952")

@modify(hdg, fixed 1)
@modify(Heading, leftmargin 0, flushleft, above 2, need 5)
@modify(Subheading, leftmargin 1, flushleft, above 2, need 4)

@Generate(Outline,Contents)
@Send(Contents "@NewPage(0)@Set(Page=LastPreContentsPage,page=+1)@Style(PageNum
ber <@i>)")
@Send(Contents "@PrefaceSection(Table of Contents)")

@define(foot, break around, afterentry 'NOTE: ',
    leftmargin +8, indent -6, rightmargin +2)
@define(note = foot)

@Define    (HDX,Hyphenation off,
    LeftMargin 0,Indent 0,Fill,Spaces compact,Above 1,Below 0,
      break,need 4,Justification Off)
@Define    (Hd0,Use HdX,Above 1inch,Below 0.5inch)
@Define(Hd1,Use HdX,Above 3, below 1, capitalized)
@Define(HD1A=HD1,Centered)
@Define(Hd2,Use HdX,Above 2, below 1)
@Define(Hd3,Use HdX,Above 1)
@Define(Hd4,Use HdX,Above 1)
@Define(TcX,LeftMargin 5,Indent -5,RightMargin 5,Fill,Spaces compact,
    Above 0,Spacing 1,Below 0,Break,Spread 0)
@Define(Tc0=TcX)
@Define(Tc1=TcX,Above 1)
@Define(Tc2=TcX,LeftMargin 5)
@Define(Tc3=TcX,LeftMargin 10)
@Define(Tc4=TcX,LeftMargin 15)
@Counter(MajorPart,TitleEnv HD0,ContentsEnv tc0,Numbered [@I],
      IncrementedBy Use,Announced)
@Counter(Chapter,TitleEnv HD1,ContentsEnv tc1,Numbered [@1.],
      IncrementedBy Use,Referenced [@1],Announced)
@Counter(Appendix,TitleEnv HD1,ContentsEnv tc1,Numbered [@I.],
      IncrementedBy,Referenced [@I],Announced,Alias Chapter)
@Counter(UnNumbered,TitleEnv HD1,ContentsEnv tc1,Announced,Alias Chapter)
@Counter(Section,Within Chapter,TitleEnv HD2,ContentsEnv tc2,
      Numbered [@#@:.@1],Referenced [@#@:.@1],IncrementedBy Use,Announced)
@Counter(AppendixSection,Within Appendix,TitleEnv HD2,ContentsEnv tc2,
      Numbered [@#@:.@1],Referenced [@#@:.@1],IncrementedBy Use,Announced)
@Counter(SubSection,Within Section,TitleEnv HD3,ContentsEnv tc3,
      Numbered [@#@:.@1],IncrementedBy Use,Referenced [@#@:.@1])
@Counter(Paragraph,Within SubSection,TitleEnv HD4,ContentsEnv tc4,
      Numbered [@#@:.@1],Referenced [@#@:.@1],IncrementedBy Use)

@Counter(PrefaceSection,TitleEnv HD1A,Alias Chapter)

@LibraryFile(Figures)
@LibraryFile(Titlepage)

@string(emdash='--')
@string(endash='-')
@equate(k=value)

@form(RFC '
    @begin(text, leftmargin 0)
    @Begin(FlushLeft, fixed 1)
@parm(WG)
Request for Comments: @Parm(Number)
    @end(FlushLeft)
    @blankspace(-2)
    @Begin(FlushRight, fixed 1)
    @Parm(Authors)
    @Value(date)
    @End(FlushRight)

    @blankspace(4)
    @titletext@parmquote(title)
    @end(text)

@PageHeading(Left "RFC @parm(Number)", Center "@parm(ShortTitle)",
        Right "@parm(Date)")
@PageFooting(immediate, Left "@parm(ShortAuthors)", Right "[Page @value(page)]"
)
')

@form(InternetDraft '
    @begin(text, leftmargin 0)
    @Begin(FlushLeft, fixed 1)
@parm(WG)
Internet-Draft
    @end(FlushLeft)
    @blankspace(-2)
    @Begin(FlushRight, fixed 1)
    @Parm(Authors)
    @Value(date)
    @End(FlushRight)

    @blankspace(4)
    @titletext@parmquote(title)
    @end(text)

@PageHeading(Left "Internet-Draft", Center "@parm(ShortTitle)",
        Right "@parm(Date)")
@PageFooting(immediate, Left "@parm(ShortAuthors)", Right "[Page @value(page)]"
)
')

@Define(Abstract, Use BodyStyle, Fill, above 0, below 1,
    LeftMargin +.5 inch, RightMargin +.5 inch,
    beforeentry "@heading(Abstract)")
@define(status, use abstract,
    beforeentry "@heading(Status of this Memo)")
@Define(TitleText, Use MajorHeading, capitalized off, above 0)

@Modify(EquationCounter,Within Chapter,Numbered <(@#@:.@1)>,
    Referenced "(@#@:.@1)")
@Modify(TheoremCounter,Within Chapter)

@Equate(Sec=Section,Subsec=SubSection,Chap=Chapter,Para=Paragraph,
    SubSubSec=Paragraph,AppendixSec=AppendixSection)

@Begin(Text,Indent 0,Spread 1,Use BodyStyle,LineWidth 72,
    Spaces Compact,
    Justification,Font CharDef,FaceCode R)

@set(page=1)
@string(LastPreContentsPage="1")

@begin(text, leftmargin 3, eofok)


@Marker(Make,RFC,ScaleableLaser,PostScript)

@LibraryFile(SansSerif)
@Define(BodyStyle, Font BodyFont, Spacing 1.3, Spread 0.8, Size 11, Indent 0)
@Define(NoteStyle, Font BodyFont, FaceCode R, Spacing 1, Size 9, Indent 0)

@Style(Hyphenation Off)
@Style(WidowAction ForceWarn)
@Style(References=CACM)
@Style(Date= "March 1952", FileDate= "March 1952")

@modify(Heading, leftmargin 0, flushleft, above 2, need 5)
@modify(Subheading, leftmargin 1, flushleft, above 2, need 4)
@modify(programexample, size +0)
@modify(fileexample, size +0)

@Generate(Outline,Contents)
@Send(Contents "@PrefaceSection(Table of Contents)")
@Send(Contents "@Style(PageNumber <@i>)@Set(Page=1)")
@Send(Contents "@Process(PageHeadings)")
@Send(Contents "@define(foot,invisible)")

@textform(note = '@foot@parmquote(text)')

@Define    (HDX, Hyphenation off,
    LeftMargin 0,Indent 0,Fill, Spaces compact, Below 0,
      break,need 4,Justification Off, font TitleFont, FaceCode B)
@Define(Hd0, Use HdX, Size +5, Above 1inch, Below 0.5inch)
@Define(Hd1, Use HdX, Size +3, Above 2.5, below 1)
@Define(HD1A=HD1,Centered)
@Define(Hd2, Use HdX, Size +2, Above 2, below 1)
@Define(Hd3, Use HdX, Size +1, Above 1)
@Define(Hd4, Use HdX, Size +0, Above 1)
@Define(TcX,LeftMargin 5,Indent -5,RightMargin 5,Fill,Spaces compact,
    Above 0,Spacing 1,Below 0,Break,Spread 0)
@Define(Tc0=TcX, LeftMargin  0, Above 1.2)
@Define(Tc1=TcX, LeftMargin  4, Above .8)
@Define(Tc2=TcX, LeftMargin  8)
@Define(Tc3=TcX, LeftMargin 12)
@Define(Tc4=TcX, LeftMargin 16)
@Counter(MajorPart,TitleEnv HD0,ContentsEnv tc0,Numbered [@I],
      IncrementedBy Use,Announced)
@Counter(Chapter,TitleEnv HD1,ContentsEnv tc1,Numbered [@1.],
      IncrementedBy Use,Referenced [@1],Announced)
@Counter(Appendix,TitleEnv HD1,ContentsEnv tc1,Numbered [@I.],
      IncrementedBy,Referenced [@I],Announced,Alias Chapter)
@Counter(UnNumbered,TitleEnv HD1,ContentsEnv tc1,Announced,Alias Chapter)
@Counter(Section,Within Chapter,TitleEnv HD2,ContentsEnv tc2,
      Numbered [@#@:.@1],Referenced [@#@:.@1],IncrementedBy Use,Announced)
@Counter(AppendixSection,Within Appendix,TitleEnv HD2,ContentsEnv tc2,
      Numbered [@#@:.@1],Referenced [@#@:.@1],IncrementedBy Use,Announced)
@Counter(SubSection,Within Section,TitleEnv HD3,ContentsEnv tc3,
      Numbered [@#@:.@1],IncrementedBy Use,Referenced [@#@:.@1])
@Counter(Paragraph,Within SubSection,TitleEnv HD4,ContentsEnv tc4,
      Numbered [@#@:.@1],Referenced [@#@:.@1],IncrementedBy Use)

@Counter(PrefaceSection,TitleEnv HD1A,Alias Chapter)

@LibraryFile(Figures)
@LibraryFile(Titlepage)

@form(RFC '
    @begin(text, leftmargin 0, FaceCode B)
    @Begin(FlushLeft, fixed .5in)
@parm(WG)
Request for Comments: @Parm(Number)
    @end(FlushLeft)
    @blankspace(-2)
    @Begin(FlushRight, fixed .5in)
    @Parm(Authors)
    @Value(date)
    @End(FlushRight)

    @titletext@parmquote(title)
    @end(text)
@PageHeading(Left "RFC @parm(Number)", Center "@parm(ShortTitle)",
        Right "@parm(Date)")
@PageFooting(immediate, Left "@parm(ShortAuthors)", Right "[Page @value(page)]"
)
')

@form(InternetDraft '
    @begin(text, leftmargin 0)
    @Begin(FlushLeft, fixed .5in)
@parm(WG)
Internet-Draft
    @end(FlushLeft)
    @blankspace(-2)
    @Begin(FlushRight, fixed .5in)
    @Parm(Authors)
    @Value(date)
    @End(FlushRight)

    @blankspace(4)
    @titletext@parmquote(title)
    @end(text)

@PageHeading(Left "Internet-Draft", Center "@parm(ShortTitle)",
        Right "@parm(Date)")
@PageFooting(immediate, Left "@parm(ShortAuthors)", Right "[Page @value(page)]"
)
')

@Define(Abstract, Use BodyStyle, Fill, above 3, below 2,
    LeftMargin +.5 inch, RightMargin +.5 inch)
@define(status, use abstract, above 0,
    beforeentry "@heading(Status of this Memo)")
@Define(TitleText, Use MajorHeading, capitalized off, above 4)

@Modify(EquationCounter,Within Chapter,Numbered <(@#@:.@1)>,
    Referenced "(@#@:.@1)")
@Modify(TheoremCounter,Within Chapter)

@Equate(Sec=Section,Subsec=SubSection,Chap=Chapter,Para=Paragraph,
    SubSubSec=Paragraph,AppendixSec=AppendixSection)

@Begin(Text, Use BodyStyle,
    LeftMargin 1in, LineWidth 6.5in, topmargin 1in, BottomMargin 1in,
    hyphenation off, justification on,
    FaceCode R, eofok)


@set(page=1)
@string(LastPreContentsPage="1")

@begin(text, leftmargin 3, eofok)


@Marker(Make,ChangeLog)
@Comment[
18 Jul 84  JCM    First cut at an RFC document.
 1 Apr 87  GMT  Revised format (pagedfile only) to work really well.
        Really ought to put most things in a common library.
 9 Jul 91  GMT    Added "status" and "abstract" definitions.  Added
        InternetDraft macro.
]